home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d19 / ip131.arc / IP.DOC < prev    next >
Text File  |  1991-06-06  |  17KB  |  376 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                                InterPCB 1.31
  7.                            Revised Aug 24, 1990
  8.  
  9.  
  10.  
  11.  
  12.  
  13.                   Copyright 1990 InterZone Software, Inc.
  14.                             All Rights Reserved
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.                                 Written by
  22.                     Peter Stewart and Michele Hamilton
  23.  
  24.  
  25.  
  26.  
  27.                                 FILES LIST
  28.                                 ==========
  29.  
  30.           IP.EXE         Program
  31.           IP.BAT         Sample batch file
  32.           IP.DOC         This documentation
  33.           WIPE.EXE       Utility to delete all files with the same extension.
  34.           INTERZ.REG     Registration Form
  35.           IP.NEW         History of new options and fixes
  36.  
  37.  
  38.                                INTRODUCTION
  39.                                ============
  40.  
  41.      This program was born out of the frustration with the existing 
  42.      programs to import Fido-style messages into a PCBoard  message base  
  43.      and visa versa. The programs that were out there when we started
  44.      work on it were too big, too slow and/or too unreliable.
  45.  
  46.      So we wrote InterPCB. It is a fast, simple, easy to use commandline 
  47.      program that will take each fido *.msg and import it into a PCBoard
  48.      message base, updating the index and even reformatting. It ain't 
  49.      pretty, but it does what it's supposed to do time after time
  50.      after time. Which is, after all, what a program should always be.
  51.  
  52.  
  53.                     NOTICES, WARRANTIES AND GUARANTEE
  54.                     =================================
  55.  
  56.      This program has no warranty or guarantee other than to take up
  57.      space on your hard drive. This program is Shareware and should be
  58.      considered user supported software.
  59.  
  60.      This program MAY NOT be commercially reproduced or sold by anyone.
  61.      This includes as part of a software library in which the user pays
  62.      for the cost of the disk. The author reserves all rights to this
  63.      program.
  64.  
  65.      This program is distributed as SHAREWARE. This means that, if you like
  66.      the program and continue to use it for more than 2 weeks, you must
  67.      register it. Registration will entitle you to full support through
  68.      FidoNet or BBSNet Netmail or the Support boards listed below.
  69.  
  70.      Additionally, you will be allowed to download future beta versions
  71.      of InterPCB. To be listed as a future beta tester, call SunShine
  72.      PCBoard and fill out Questionnaire #3. Future versions will be Netmail
  73.      capable with Door support for locating net/node numbers, user account-
  74.      ing, etc.
  75.  
  76.      To register this program, mail your check or money order for $20.00,
  77.      together with the registration form, to:
  78.  
  79.                      InterZone Software, Inc.
  80.                      161 Madeira Avenue, Suite 57
  81.                      Coral Gables, Florida 33134
  82.  
  83.                               ABOUT INTERPCB
  84.                               ==============
  85.  
  86.      InterPCB exports messages from the PCBoard message bases to the *.msg
  87.      format that is standard in Fidonet. It will also import incoming 
  88.      messages in *.msg format to the PCBoard message bases. To be able to
  89.      participate in echomail conferences, you must also use an echomail
  90.      processor, like ConfMail or TosScan.
  91.      
  92.      Using InterPCB is fairly straight forward. To get a list of options or 
  93.      help, simply type "IP" with no arguments. InterPCB does not require a
  94.      configuration file and is most easily run as an event through a batch 
  95.      file.
  96.  
  97.      After the import/export stage is finished, it is not necessary to pack
  98.      the message bases.
  99.  
  100.      The order in which the directory, pathname and other parameters are
  101.      listed is optional.
  102.  
  103.      Should a *.msg that has been exported from your message base not have
  104.      been deleted from the directory after being processed by your echomail
  105.      handler or your batch file, InterPCB will NOT re-import that message 
  106.      when next it scans that directory for import.
  107.  
  108.      CAUTION:
  109.      If you are running ConfMail or an echomail processor other than TosScan,
  110.      InterPCB will have no way of knowing whether or not the message has
  111.      been sent since, as far as we know, TosScan is the only program which
  112.      toggles a 'sent' bit. Make sure that you either do NOT use an external
  113.      message editor or that you process your export of mail BEFORE attempt-
  114.      ing to use InterPCB to import messages. If you don't take these pre-
  115.      cautions this could cause the messages to be imported into PCBoard and
  116.      deleted from the Fido directory without being sent. (However, see the
  117.      /l (leave) option below.)
  118.  
  119.      InterPCB kills all *.msg files after they have been imported to a
  120.      message base - unless you use the /l (leave) option. However, it also 
  121.      reads and/or toggles the following bits in any *.msg file to be imported 
  122.      or exported from a PCBoard message base in order to determine if the 
  123.      message should be deleted or not. You obviously don't want a message 
  124.      deleted if it has not been processed for echomail handling yet.
  125.  
  126.  
  127.      -local         IP will set the local  bit "on" automatically for all
  128.                     messages  exported from  a PCBoard message base. This
  129.                     will allow TosScan to know that this message is local
  130.                     to the system and needs to be exported for mailing.
  131.  
  132.      -transit       IP will toggle the transit status automatically
  133.                     for all messages exported from or to a PCBoard message
  134.                     base. This allows IP to recognize that it has already
  135.                     imported/exported this message and to ignore it if it
  136.                     sees it again. If a message was written by an external
  137.                     editing program such as InterMail's or FrontDoor's
  138.                     editor or Xpress, but not yet sent out, after importing
  139.                     it to PCBoard IP will set the 'transit' bit on, so it
  140.                     knows that it shouldn't re-import the message. DO NOT
  141.                     use an external editor if you are using an echomail
  142.                     processor that doesn't use the 'Sent' bit!
  143.  
  144.      -sent          IP looks for the 'sent' bit and if not found, will import
  145.                     a locally entered message to your message base but will
  146.                     leave it in your directory for echomail handling.
  147.  
  148.  
  149.                             HOW TO USE InterPCB
  150.                             ===================
  151.  
  152.      The command syntax for InterPCB is as follows:
  153.  
  154.  
  155.      IP [options] /F:directory /P:pathname [options]
  156.  
  157.  
  158.      /inst          INSTALL. Use to install the sysop's name, a pathname for 
  159.                     the log file, and an export areas file.
  160.  
  161.                     IP will automatically insert the sysop's name to replace
  162.                     SYSOP as originator/recipient of a local message.
  163.  
  164.                     If no log file name is installed, no statistics or error
  165.                     messages will be logged.
  166.  
  167.                     The export areas file is described below under the
  168.                     /n:name parameter.
  169.  
  170.                     NOTE: The installation is saved to the program file
  171.                     itself (IP.EXE), so the program has to be reinstalled
  172.                     every time you install a new version on your system.
  173.                     To see the current installation, you can just type IP
  174.                     without any parameters.
  175.  
  176.      /i             IMPORT. Tells InterPCB to import *.msg files to a PCBoard 
  177.                     message base. Can be used together with the /e (export) 
  178.                     option below, so that messages are both imported and 
  179.                     exported in the same run.
  180.  
  181.      /e             EXPORT. Tells InterPCB to export mail from a PCBoard 
  182.                     message base to *.msg files. Can be used together with 
  183.                     the /i (import) option above.
  184.  
  185.      /f:directory   FIDO directory. Where the *.msg files can be found.
  186.  
  187.      /p:pathname    PCBOARD message base. Path and file name of the PCBoard 
  188.                     message base.
  189.  
  190.      /n:name        Optional AREA NAME, to be used together with an installed 
  191.                     export areas file. The area name specified with this 
  192.                     parameter gets written to the export areas file if any
  193.                     messages have been exported. The export file can then
  194.                     be used to tell your echomail processor which areas to
  195.                     process.
  196.  
  197.                     NOTE: It is important that the export areas file is
  198.                     removed after processing in your batch file, since IP
  199.                     can't tell when it should be deleted. IP has no code
  200.                     to check if an area already has been added to the export
  201.                     file, so duplicate entries are possible if the file
  202.                     isn't removed properly. And finally: do NOT confuse this 
  203.                     "disposable" file with your AREAS.BBS file!
  204.  
  205.      /max:nnn       MAX lines, optional. Where 'nnn' is the maximum number 
  206.                     of lines InterPCB should process on importing a message 
  207.                     to a PCB message base. Default is 99 lines as currently 
  208.                     supported by PCB 14.2 and below. However, in the new 
  209.                     PCBoard 14.5, you will have an option to increase your 
  210.                     message base lines to 200. This option allows you to 
  211.                     reset InterPCB's maximum number of lines to import.
  212.  
  213.      /s             SPLIT, optional. By default, InterPCB will truncate all 
  214.                     messages over the 99 lines or the maximum number of lines 
  215.                     as set by the /MAX:nnn parameter. Using the /s parameter 
  216.                     will tell InterPCB to split a long fido message, that 
  217.                     would otherwise be truncated, into two or more messages
  218.                     in the PCBoard message base.
  219.  
  220.      /a             ALL, optional. To avoid having to scan all messages each 
  221.                     time InterPCB processes an export it will, by default, 
  222.                     make and use a zero byte file that serves to tell it the 
  223.                     last message number. Use the /A parameter to ignore this 
  224.                     and process ALL messages in a base.
  225.  
  226.      /k             KEEP seen-by lines, optional. Use if you wish to keep 
  227.                     seen-by lines. The default is that all seen-by lines are 
  228.                     stripped from the messages. (Seen-by lines are inserted
  229.                     by echomail processors and used in detecting/tracking down
  230.                     duplicate messages.)
  231.  
  232.      /h             HIGH-END ASCII, optional. IP will now strip high-end ASCII 
  233.                     characters on export from PCB. This option will allow you 
  234.                     to retain the characters in the range 128-254, if desired.
  235.                     (High-end ASCII characters are generally not allowed in
  236.                     Fidonet conferences, since they may cause problems for 
  237.                     people running non-PC compatible machines. You should 
  238.                     never allow high-end ASCII in general Fidonet echomail
  239.                     conferences.)
  240.  
  241.      /w             WIDE, optional. Permits "wide" wrapping to 80 columns of 
  242.                     long lines ending with a hard CR. IP will still attempt 
  243.                     to fit lines with soft CRs within 72 columns.
  244.  
  245.      /l             LEAVE, optional. Allows the option of leaving messages in 
  246.                     the *.msg format on import to PCB.
  247.  
  248.      /o             Echo flag ON, optional. Turns the "Echo" flag on in 
  249.                     imported messages and leaves it on in exported messages. 
  250.                     This is mainly useful for systems gating conferences
  251.                     between networks. IP will no longer exclusively rely on 
  252.                     the Echo flag to know if it has processed a message. 
  253.                     However, it will still require the Echo flag to be on 
  254.                     to export a message.
  255.  
  256.  
  257.                                 ORIGIN LINES
  258.                                 ============
  259.  
  260.      You can have IP add an origin line. The origin line should be
  261.      stored in each PCBoard message directory in a plain ASCII file called
  262.      ORIGLINE.IP, e.g.:
  263.  
  264.             I'm proud of my Origin! (1:135/21)
  265.  
  266.      Tearline and " * Origin: " will be added to this text by IP.
  267.      IP will only add the origin line if it finds this file in the
  268.      PCBoard message base directory. and if there isn't already a
  269.      recognizable origin line in the message.
  270.  
  271.  
  272.                               EXPORTING MESSAGES
  273.                               ==================
  274.  
  275.      In order to export messages from PCBoard message bases, IP requires
  276.      that the ECHO flag be set. You MUST make sure to have "Echo Mail in
  277.      Conferences" set to yes in your PCBSETUP for each conference that 
  278.      needs to be exported.
  279.  
  280.      A sample batchfile has been included (IP.BAT) showing some of the ways
  281.      in which options may be used and errorhandling.
  282.  
  283.  
  284.                               INTERRUPTING IP
  285.                               ===============
  286.  
  287.      IP can be interrupted at any time by pressing Ctrl-C or Ctrl-Break.
  288.      This should be considered an "emergency brake", though. We would
  289.      recommend that you use it during the export phase, if possible,
  290.      rather than during import.
  291.  
  292.      IP will properly close all open files, but if interrupted during import,
  293.      IP won't delete imported *.msg files or update the PCBoard index, so
  294.      it will be necessary to run a pack program to take care of dupes and
  295.      update the indexes the next time you import messages.
  296.  
  297.  
  298.                                 ERRORLEVELS
  299.                                 ===========
  300.  
  301.           0    Success (no errors)
  302.           1    No messages to import
  303.           2    Fatal error (terminate)
  304.           3    Insufficient space on disk (terminate)
  305.           4    Invalid parameters
  306.           5    PCBoard message base locked (terminate)
  307.           6    Insufficient space in PCB index (increase block size)
  308.          10    User break (Ctrl-C or Ctrl-Break)
  309.  
  310.      These errorlevels may be picked up and used in a batch file to take
  311.      appropriate action. See sample batch file enclosed.
  312.  
  313.  
  314.  
  315.                                 Definitions
  316.                                 -----------
  317.  
  318.      Directory:     A DOS directory name, e.g. C:\PCB
  319.  
  320.      Pathname:      A complete filename including the path,
  321.                     e.g. E:\FD\PCBNET\PCBNET
  322.  
  323.  
  324.                                    WIPE
  325.                                    ====
  326.  
  327.      Wipe is similar to PCMag's sweep.com in that it will delete all files
  328.      on a drive.  The syntax is:
  329.  
  330.      WIPE [drive:][path][.ext] [/b] [/e]
  331.  
  332.      All parameters are optional.  The default is for Wipe to delete all
  333.      files with the extension BAK on the current drive and require 
  334.      confirmation of each deletion.
  335.  
  336.      If you specify a path, WIPE will only search downwards in the directory
  337.      tree from the specified path.
  338.  
  339.      The /b parameter (for batch mode) is necessary to operate WIPE from a
  340.      batch file.  The extensions .exe, .com, .sys, .bat, .ovr, and .ovl are
  341.      illegal for batch mode operation.
  342.  
  343.      The /e parameter is only necessary if you are in the habit of using
  344.      directory names with extensions, e.g. D:\PCB.NET\MSG.FIL\  (Very few
  345.      people do...)
  346.  
  347.  
  348.                                   CREDITS
  349.                                   =======
  350.  
  351.      All InterZone products are trademarks or registered trademarks of
  352.      InterZone Software, Inc.
  353.  
  354.  
  355.      InterMail 2.00 (c) 1990 InterZone Software, Inc., is a mailer program
  356.      developed and marketed by InterZone Software, Inc.
  357.  
  358.      TosScan 1.0 was written by Joaquim Homrighausen.
  359.  
  360.      FrontDoor 1.99c (c) 1990 Joaquim Homrighausen. Written by Joaquim
  361.      Homrighausen and Peter Stewart.
  362.  
  363.      PCBoard is a registered trademark of Clark Development Company and CDC
  364.      does not support this program.
  365.  
  366.      Other brand and product names are trademarks or registered trademarks
  367.      of their respective holders.
  368.  
  369.  
  370.      Support:  BBS: The InterZone Cafe (305)436-1085 <HST>
  371.                FidoNet Node 1:369/35 <HST>
  372.  
  373.                BBS: SunShine PCBoard (305)432-2223 <HST>
  374.                FidoNet Node 1:369/21 <HST>
  375.                EchoNet Node 50:5305/21 <HST>
  376.